package com.aura.blog.config;

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Contact;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.info.License;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * Swagger API文档配置类
 * 该配置类用于自定义Swagger UI的显示信息，包括API文档标题、描述、版本、联系人信息和许可证信息。
 * 通过该配置，开发者和API使用者可以更清晰地了解系统的功能和使用方式。
 */
@Configuration
public class SwaggerConfig {

    /**
     * 自定义OpenAPI配置
     *
     * @return OpenAPI 配置对象
     */
    @Bean
    public OpenAPI customOpenAPI() {
        return new OpenAPI()
                .info(new Info()
                        .title("Aura博客系统API接口文档")
                        .version("1.0.0")
                        .description("Aura博客系统是一个基于Spring Boot开发的博客管理平台，提供用户认证、博客文章的增删改查等核心功能。"
                                + "本系统采用JWT进行用户身份验证，使用MyBatis-Plus作为ORM框架，实现了高性能的数据库操作。"
                                + "文档详细描述了所有RESTful API接口的使用方式，便于前后端开发人员快速集成和调试。")
                        .contact(new Contact()
                                .name("Aura Blog作者Git链接")
                                .email("aura.blog@example.com")
                                .url("https://gitee.com/have-a-cup-of-java11"))
                        .license(new License()
                                .name("Apache 2.0")
                                .url("https://www.apache.org/licenses/LICENSE-2.0")));
    }
}